Skip to content

Adds some general information about considerations for upgrades #7288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

AndyButland
Copy link
Contributor

πŸ“‹ Description

Adds some general information about considerations for upgrades

βœ… Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (β€œwe”, β€œI”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

Umbraco CMS

Deadline (if relevant)

Any time. Once approved can be copied to at least the Umbraco 13 pages, so we have it on the last LTS.

@sofietoft
Copy link
Contributor

Thanks for the PR @AndyButland !

While I think this is very valuable information, I'm concerned about adding it to an already very long article.
Perhaps we could add this information into the "Expandables", like the ones we use in the Breaking Changes section? That way the information is not adding too much to the length of the article, and it's an opt-in to learn more about it.

That's my two cents.
In the docs team, we have an upcoming project to look into how we structure these upgrade docs, and hopefully make them a little easier to navigate.

@AndyButland
Copy link
Contributor Author

I see the point @sofietoft but what I was aiming for here was a general introduction to upgrades that is worth reading before you dive into the detail. As I do see some confusion about what we are talking about when we discuss these. So rather than hiding it in an expandable section, if you feel this page is too long, I think I'd prefer moving what I've added to a new page and placing it before the existing one in the summary. Then you can dive straight into the detail if you know the background, but if not, you'll hopefully see this new content first.

Let's get @BoletteKern's view too though - as this I've put this together following a request she had having had some feedback on this topic.

@sofietoft
Copy link
Contributor

Yes, splitting up is also a good idea! We can always highlight the page with a link from the article, as something we recommend going through before initiating the upgrade process.

We'll wait for Bolette, before we make any changes for now πŸ™

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants